---
title: pxf
---

Manage the PXF configuration and the PXF Service instance on the local Greenplum Database host.

## <a id="topic1__section2"></a>Synopsis

``` pre
pxf <command> [<option>]
```

where \<command\> is:

``` pre
cluster
help
init (deprecated)
prepare
register
reset (deprecated)
restart
start
status
stop
sync
version
```

## <a id="topic1__section3"></a>Description

The `pxf` utility manages the PXF configuration and the PXF Service instance on the local Greenplum Database host. You can use the utility to:

- Synchronize the PXF configuration from the master to the standby master or to a segment host.
- Start, stop, or restart the PXF Service instance on a specific segment host, or display the status of the PXF Service instance running on a segment host.
- Copy the PXF extension control file from a PXF installation on the host to the Greenplum installation on the host after a Greenplum upgrade.
- Prepare a new `$PXF_BASE` runtime configuration directory on the host.

(Use the [`pxf cluster`](pxf-cluster.html#topic1) command to prepare a new `$PXF_BASE` on all hosts, copy the PXF extension control file to `$GPHOME` on all hosts, synchronize the PXF configuration to the Greenplum Database cluster, or to start, stop, or display the status of the PXF Service instance on all segment hosts in the cluster.)

## <a id="commands"></a>Commands

<dt>cluster</dt>
<dd>Manage the PXF configuration and the PXF Service instance on all Greenplum Database hosts. See [`pxf cluster`](pxf-cluster.html#topic1).</dd>

<dt>help</dt>
<dd>Display the `pxf` management utility help message and then exit.</dd>

<dt>init (deprecated)</dt>
<dd>The command is equivalent to the `register` command.</dd>

<dt>prepare</dt>
<dd>Prepare a new `$PXF_BASE` directory on the host. When you run the command, you must identify the new PXF runtime configuration directory via an environment variable named `PXF_BASE`. PXF copies runtime configuration file templates and directories to this `$PXF_BASE`.</dd>

<dt>register</dt>
<dd>Copy the PXF extension files from the PXF installation on the host to the Greenplum installation on the host. This command requires that `$GPHOME` be set, and is run once after you install PXF 6.x the first time, or run when you upgrade your Greenplum Database installation.</dd>

<dt>reset (deprecated)</dt>
<dd>The command is a no-op.</dd>

<dt>restart</dt>
<dd>Restart the PXF Service instance running on the segment host.</dd>

<dt>start</dt>
<dd>Start the PXF Service instance on the segment host.</dd>

<dt>status</dt>
<dd>Display the status of the PXF Service instance running on the segment host.</dd>

<dt>stop  </dt>
<dd>Stop the PXF Service instance running on the segment host.</dd>

<dt>sync  </dt>
<dd>Synchronize the PXF configuration (`$PXF_BASE`) from the master to a specific Greenplum Database standby master or segment host. You must run `pxf sync` on the master host. By default, this command updates files on and copies files to the remote. You can instruct PXF to also delete files during the synchronization; see [Options](#options).</dd>

<dt>version  </dt>
<dd>Display the PXF version and then exit.</dd>

## <a id="options"></a>Options

The `pxf sync` command, which you must run on the Greenplum Database master host, takes the following option and argument:

<dt>&#8211;d | &#8211;&#8211;delete </dt>
<dd>Delete any files in the PXF user configuration on `<gphost>` that are not also present on the master host. If you specify this option, you must provide it on the command line before `<gphost>`.</dd>

<dt>\<gphost\> </dt>
<dd>The Greenplum Database host to which to synchronize the PXF configuration. Required. `<gphost>` must identify the standy master host or a segment host.</dd>

## <a id="topic1__section5"></a>Examples

Start the PXF Service instance on the local segment host:

``` shell
$ pxf start
```

## <a id="topic1__section6"></a>See Also

[`pxf cluster`](pxf-cluster.html#topic1)
